﻿#region Copyright
// Copyright (c) 2011-2012 RaisingForce Team (Alikin Sergey)
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using System;
using System.Diagnostics.Contracts;
using RaisingForce.Raise.Measures;

namespace RaisingForce.Raise.Hardware
{
    /// <summary>
    /// Представляет интерфейс доступа к двигателю робота.
    /// <para>Это абстрактный класс по умолчанию для интерфейса <see cref="IRobotEngine"/>.</para>
    /// </summary>
    [ContractClass(typeof(RobotEngineContract))]
    public abstract class RobotEngine :
        IRobotEngine
    {
        #region Constructors

        /// <summary>
        /// Создает экземпляр класса <see cref="RobotEngine"/>.
        /// </summary>
        /// <param name="hardwareSyncObject">Объект синхронизации для доступа
        /// к открытым членам интерфейса <see cref="IRobotHardware"/>.</param>
        protected RobotEngine(object hardwareSyncObject)
        {
            if (hardwareSyncObject == null)
            {
                throw new ArgumentNullException("hardwareSyncObject");
            }
            Contract.EndContractBlock();
            this.hardwareSyncObject = hardwareSyncObject;
        }

        #endregion

        #region Private Declarations

        private readonly object hardwareSyncObject;

        private readonly object engineSyncObject = new object();

        [ContractInvariantMethod]
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic", Justification = "Required for code contracts.")]
        private void ObjectInvariant()
        {
            Contract.Invariant(this.hardwareSyncObject != null);
            Contract.Invariant(this.engineSyncObject != null);
        }

        private void actionWithEngine(Action action, string failureMessage)
        {
            Contract.Requires(action != null);
            Contract.Requires(failureMessage != null);
            try
            {
                action();
            }
            catch (RobotHardwareException)
            {
                throw;
            }
            catch (Exception ex)
            {
                throw new RobotHardwareException(
                    RobotHardwareFailureReason.Hardware,
                    failureMessage,
                    innerException: ex);
            }
        }

        #endregion

        #region Protected Abstract Declarations

        /// <summary>
        /// Выполняет поворот робота вокруг своей оси на заданный угол в указанном направлении.
        /// <para>Этот метод нужно переопределить в классах-наследниках для
        /// задания логики поведения открытому методу <see cref="Rotate"/>.</para>
        /// </summary>
        /// <param name="rotationAngle">Угол, на который робот должен повернуться.</param>
        /// <param name="rotationDirection">Направление поворота - либо по часовой, либо против часовой стрелки.</param>
        protected abstract void RotateHardware(
            Angle rotationAngle,
            RotationDirection rotationDirection);

        /// <summary>
        /// Выполняет движение робота на заданное расстояние в указанном направлении (вперед или назад).
        /// <para>Этот метод нужно переопределить в классах-наследниках для
        /// задания логики поведения открытому методу <see cref="Move"/>.</para>
        /// </summary>
        /// <param name="movementDistance">
        /// Расстояние, на которое робот должен переместиться по направлению
        /// своего движения. Значение <c>Distance.Unknown</c> недопустимо.</param>
        /// <param name="movementDirection">
        /// Направление движения робота - вперед или назад.</param>
        protected abstract void MoveHardware(
            Distance movementDistance,
            MovementDirection movementDirection);

        /// <summary>
        /// Подаёт команду двигателю робота на немедленную остановку
        /// и дожидается окончания работы двигателя.
        /// <para>Этот метод нужно переопределить в классах-наследниках для
        /// задания логики поведения открытому методу <see cref="Stop"/>.</para>
        /// </summary>
        protected abstract void StopHardware();

        #endregion

        #region IRobotEngine Members

        /// <summary>
        /// Выполняет поворот робота вокруг своей оси на заданный угол в указанном направлении.
        /// </summary>
        /// <param name="rotationAngle">Угол, на который робот должен повернуться.</param>
        /// <param name="rotationDirection">Направление поворота - либо по часовой, либо против часовой стрелки.</param>
        /// <exception cref="RobotHardwareException">
        /// Произошла ошибка с оборудованием или робот не ответил вовремя.
        /// </exception>
        /// <seealso cref="IRobotEngine"/>
        /// <seealso cref="RobotHardwareException"/>
        public void Rotate(
            Angle rotationAngle,
            RotationDirection rotationDirection)
        {
            lock (this.hardwareSyncObject)
            {
                lock (this.engineSyncObject)
                {
                    this.actionWithEngine(
                        () => this.RotateHardware(rotationAngle, rotationDirection),
                        RobotHardwareExceptionMessages.EngineRunError);
                }
            }
        }

        /// <summary>
        /// Выполняет движение робота на заданное расстояние в указанном направлении (вперед или назад).
        /// </summary>
        /// <param name="movementDistance">
        /// Расстояние, на которое робот должен переместиться по направлению
        /// своего движения. Значение <c>Distance.Unknown</c> недопустимо.</param>
        /// <param name="movementDirection">
        /// Направление движения робота - вперед или назад.</param>
        /// <exception cref="RobotHardwareException">
        /// Произошла ошибка с оборудованием или робот не ответил вовремя.
        /// </exception>
        /// <seealso cref="IRobotEngine"/>
        /// <seealso cref="RobotHardwareException"/>
        public void Move(
            Distance movementDistance,
            MovementDirection movementDirection)
        {
            lock (this.hardwareSyncObject)
            {
                lock (this.engineSyncObject)
                {
                    this.actionWithEngine(
                        () => this.MoveHardware(movementDistance, movementDirection),
                        RobotHardwareExceptionMessages.EngineRunError);
                }
            }
        }

        /// <summary>
        /// Подаёт команду двигателю робота на немедленную остановку
        /// и дожидается окончания работы двигателя.
        /// </summary>
        /// <exception cref="RobotHardwareException">
        /// Произошла ошибка с оборудованием или робот не ответил вовремя.
        /// </exception>
        /// <seealso cref="IRobotEngine"/>
        /// <seealso cref="RobotHardwareException"/>
        public void Stop()
        {
            this.actionWithEngine(
                this.StopHardware,
                RobotHardwareExceptionMessages.EngineStopError);
        }

        #endregion
    }
}
